Configure requirement traceability

This API configures Requirements Traceability Integration within the Project Configuration for a specified list of projects. It must be executed by a Tenant Admin to ensure access to all listed projects.

Note: Any existing Requirements Traceability configuration will be overwritten. However, currently mapped tickets/stories from these integrations will be retained.

PATCH{accelqLoginUrl}/awb/api/2.0/{tenantCode}/administration/projects/requirement-traceability/configure

Headers

Header	Value
`user_id`	Login username (email)
`api_key`	API key of the user for authentication
`Content-Type`	application/json
`Accept`	application/json

Parameters

Parameter	Type	Required	Description
`accelqLoginUrl`	string	Yes	The AccelQ login URL for API access.
`tenantCode`	string	Yes	Tenant code for identifying the organization.
`user_id`	string	Yes	Login username (email)
`api_key`	string	Yes	API key of the user for authentication

Select Examples:

Request Body

json

{
  "projectNames": [
    "Release Project",
    "Sanity Project",
    "Staging Project"
  ],
  "updateExisting": true,
  "traceabilityConfig": {
    "platform": "Atlassian JIRA",
    "platformURL": "https://AQ.jira.com",
    "userName": "QA.Admin",
    "password": "QAJira@123",
    "connectionMode": "BROWSER"
  }
}

Responses

200 - Bulk Integration completed with detailed results showing updated Projects, notFound Projects and skipped Projects With Traceability

json

{
  "configuredProjects": [
    "Release Project",
    "Sanity Project"
  ],
  "missingProjects": [
    "Staging Project"
  ],
  "skippedProjectsDueToExistingTraceability": []
}

400 - Bad Request - Validation errors

json

{
  "error": "Request Body is mandatory."
}

401 - Unauthorized - Invalid authentication credentials

json

{
  "error": "Invalid user credentials or API key"
}

403 - Forbidden - User does not have permission to perform this operation

json

{
  "error": "User does not have authorization to access this feature"
}

500 - Internal Server Error

json

{
  "error": "Internal error occurred while integrating Project Requirement Traceability"
}

cURL Command Builder

URL Parameters

accelqLoginUrl (string) *

tenantCode (string) *

Headers

user_id (string) *

api_key (string) *

Request Sample (cURL)

curl -X PATCH "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/administration/projects/requirement-traceability/configure" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "projectNames": [
    "Release Project",
    "Sanity Project",
    "Staging Project"
  ],
  "updateExisting": true,
  "traceabilityConfig": {
    "platform": "Atlassian JIRA",
    "platformURL": "https://AQ.jira.com",
    "userName": "QA.Admin",
    "password": "QAJira@123",
    "connectionMode": "BROWSER"
  }
}'